IKsCommand<T>.GetValueAsync (int) method

Gets a value from a device as an asynchronous operation. The method keeps waiting until time is up.

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

Task<T> GetValueAsync(
       int millisecondsTimeout,
       bool abortOnTimeout
)

Function GetValueAsync(
       millisecondsTimeout As Integer,
       abortOnTimeout As Boolean
) As Task(Of T)

Parameters

millisecondsTimeout

Type: int

The time period after which the command will be aborted, if the value is not gotten. The unit of time is millisecond.

abortOnTimeout

Type: bool

Selects if the command is aborted in case it is not finished before the timeout. true: the command will be aborted. false: the command won't be aborted.

Return value

Type: Task<T>

Represents an asynchronous operation.